org.springframework.http.codec

Class FormHttpMessageReader

java.lang.Object

org.springframework.http.codec.FormHttpMessageReader

All Implemented Interfaces:

HttpMessageReader<MultiValueMap<java.lang.String,java.lang.String>>

public class FormHttpMessageReader
extends java.lang.Object
implements HttpMessageReader<MultiValueMap<java.lang.String,java.lang.String>>

Implementation of an HttpMessageReader to read HTML form data, i.e. request body with media type "application/x-www-form-urlencoded".

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	DEFAULT_CHARSET
private java.nio.charset.Charset	defaultCharset
private static ResolvableType	MULTIVALUE_TYPE

Constructor Summary

Constructors

Constructor and Description
FormHttpMessageReader()

Method Summary

Modifier and Type	Method and Description
boolean	canRead(ResolvableType elementType, MediaType mediaType) Whether the given object type is supported by this reader.
java.nio.charset.Charset	getDefaultCharset() Return the configured default charset.
private java.nio.charset.Charset	getMediaTypeCharset(MediaType mediaType)
java.util.List<MediaType>	getReadableMediaTypes() Return the MediaType's that this reader supports.
private MultiValueMap<java.lang.String,java.lang.String>	parseFormData(java.nio.charset.Charset charset, java.lang.String body)
<any>	read(ResolvableType elementType, ReactiveHttpInputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a stream of objects.
<any>	readMono(ResolvableType elementType, ReactiveHttpInputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Read from the input message and encode to a single object.
void	setDefaultCharset(java.nio.charset.Charset charset) Set the default character set to use for reading form data when the request Content-Type header does not explicitly specify it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.http.codec.HttpMessageReader

read, readMono

Field Detail

DEFAULT_CHARSET

public static final java.nio.charset.Charset DEFAULT_CHARSET

MULTIVALUE_TYPE

private static final ResolvableType MULTIVALUE_TYPE

defaultCharset

private java.nio.charset.Charset defaultCharset

Constructor Detail

FormHttpMessageReader

public FormHttpMessageReader()

Method Detail

setDefaultCharset

public void setDefaultCharset(java.nio.charset.Charset charset)

Set the default character set to use for reading form data when the request Content-Type header does not explicitly specify it.

By default this is set to "UTF-8".

getDefaultCharset

public java.nio.charset.Charset getDefaultCharset()

Return the configured default charset.

canRead

public boolean canRead(ResolvableType elementType,
                       @Nullable
                       MediaType mediaType)

Description copied from interface: HttpMessageReader

Whether the given object type is supported by this reader.

Specified by:

canRead in interface HttpMessageReader<MultiValueMap<java.lang.String,java.lang.String>>

Parameters:

elementType - the type of object to check

mediaType - the media type for the read (possibly null)

Returns:

true if readable, false otherwise

read

public <any> read(ResolvableType elementType,
                  ReactiveHttpInputMessage message,
                  java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and encode to a stream of objects.

Specified by:

read in interface HttpMessageReader<MultiValueMap<java.lang.String,java.lang.String>>

Parameters:

elementType - the type of objects in the stream which must have been previously checked via HttpMessageReader.canRead(ResolvableType, MediaType)

message - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded stream of elements

readMono

public <any> readMono(ResolvableType elementType,
                      ReactiveHttpInputMessage message,
                      java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageReader

Read from the input message and encode to a single object.

Specified by:

readMono in interface HttpMessageReader<MultiValueMap<java.lang.String,java.lang.String>>

Parameters:

elementType - the type of objects in the stream which must have been previously checked via HttpMessageReader.canRead(ResolvableType, MediaType)

message - the message to read from

hints - additional information about how to read and decode the input

Returns:

the decoded object

getMediaTypeCharset

private java.nio.charset.Charset getMediaTypeCharset(@Nullable
                                                     MediaType mediaType)

parseFormData

private MultiValueMap<java.lang.String,java.lang.String> parseFormData(java.nio.charset.Charset charset,
                                                                       java.lang.String body)

getReadableMediaTypes

public java.util.List<MediaType> getReadableMediaTypes()

Description copied from interface: HttpMessageReader

Return the MediaType's that this reader supports.

Specified by:

getReadableMediaTypes in interface HttpMessageReader<MultiValueMap<java.lang.String,java.lang.String>>